Skip to main content

Get-IMPerson

SYNOPSIS​

Retrieves person records from face recognition.

SYNTAX​

list (Default)​

Get-IMPerson [-Session <ImmichSession>] [-WithHidden] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id​

Get-IMPerson [-Session <ImmichSession>] -id <String> [-IncludeStatistics] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Gets people identified by Immich's face recognition with optional filtering and statistics.

EXAMPLES​

EXAMPLE 1​

Get-IMPerson -IncludeStatistics

Gets all people with asset counts.

EXAMPLE 2​

Get-IMPerson -Id 'bf973405-3f2a-48d2-a687-2ed4167164be'

Gets specific person details.

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id​

Specific person ID to retrieve. Supports pipeline input.

Type: String
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-WithHidden​

Include or exclude hidden people. Omit to return all.

Type: SwitchParameter
Parameter Sets: list
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeStatistics​

Include asset count and other statistics for each person.

Type: SwitchParameter
Parameter Sets: id
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github